HSBot.transformAndReply - Code Metrics - hrdk108/hsbot - Measure and Improve Code Quality continuously with Scrutinizer

HSBot.transformAndReply A
last analyzed 2018-03-28 07:41 UTC

↳ Parent: lib/index.js

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	3
nc	3
nop	4
dl	0
loc	67
rs	9.2815
c	1
b	0
f	0

4 Functions

Rating	Size	Complexity
A	8	1
A	8	1
A	5	1
B	22	4

How to fix Long Method

/**
 * hsBot: Supply template and your bot is ready.
 * 
 * Hardik Shah <[email protected]>
 * 
 * MIT License
 */

'use strict';

var ChatDB = require('../db/chatdb');
var analysis = new(require('../analysis'))();
var userDB = new (require('../db/userdb'))();
var common = require('../util/common');

/**
 * A collection of `HSBOT` functions for talk with bot and analyze data.
 * Supply template and your bot is ready.
 * @name HSBOT
 * @constructor
 * @param {Array} topicList - A collection of JSON object.
 * @param {Array} topics - A collection of JSON object.
 * @example
 * 
 * var topicList = require('../db/data/topicList.json'); // Your file path as per defined template.
 * var topics = require('../db/data/topics.json'); // Your file path as per defined template.
 * const HSBot = require('hsbot');
 * const hsBot = new HSBot(topicList, topics);
 */
function HSBot(topicList, topics) {
  this.topicList = topicList;
  this.topics = topics;
}

/**
 * This method is responsible to reply.
 * @name transformAndReply
 * @method
 * @param {String} userId - User's ID.
 * @param {String} userName - User name.
 * @param {String} pattern - A human text or user query.
 * @return {callback} error-first callback, bot result based on user query.
 * @example
 * var topicList = require('../db/data/topicList.json'); // Your file path as per defined template.
 * var topics = require('../db/data/topics.json'); // Your file path as per defined template.
 * const HSBot = require('hsbot');
 * const hsBot = new HSBot(topicList, topics);
 * var userId = "aQ11zyTr4u7I";
 * var userName;
 *
 * hsBot.transformAndReply(userId, userName, human_text, function(err, data){
 *   console.log("HSBot:", data);
 * });
 */

HSBot.prototype.transformAndReply = function(userId, userName, pattern, cb) {
  var topicList = this.topicList;
  var topics = this.topics;
  var chatDB = new ChatDB(topicList, topics);
  pattern = common.string2literal(pattern);

  if(!userId){
    cb("UserId is not defined.");
  } else {
    var user = userDB._findUser(userId);
    var response;
    if(!user){
      response = welcomeUser();
      cb(null, response);
    } else {
      response = transform();
      cb(null, response);
    }
  }

  function welcomeUser() {
    var template = createUser();
    var postStringDict = {
      template: template,
      userName: userName
    };
    return _postTransform(postStringDict);
  }

  function createUser(){
    var topicName = chatDB._findDefaultTopic();
    var topicFlow  = chatDB.getTopicFlow(topicName);
    var templateObj  = chatDB.getTemplateObj(userName, topicFlow);
  
    userDB._insertUser(userId, userName, templateObj.pattern, templateObj.template, topicName);
    return templateObj.template;
  }

  function transform() {
    var lastIndex = user.activities.length -1;
    var preQ = user.activities[lastIndex].preQ;

    var topicName = pattern? (chatDB._findTopicByCommand(pattern) || user.activities[lastIndex].topic) : chatDB._findDefaultTopic();
    var topicFlow = chatDB.getTopicFlow(topicName);
    var templateObj = chatDB.getTemplateObj(user.userName, topicFlow, pattern, preQ);
  
    if(templateObj){
      userDB._updateUser(userId, user.userName || pattern, templateObj.pattern, templateObj.template, topicName);
    } else{
      templateObj = { template: chatDB.getDefaultMessage() };
    }

    var postStringDict = {
      template: templateObj.template,
      query: pattern,
      userName: user.userName || pattern
    };

    return _postTransform(postStringDict);
  }

  function _postTransform(resObj) {
    var s = resObj.template;
    s = s.replace(/[*]/g, resObj.query).replace("<userName>", resObj.userName);
    return s;
  }
};

/**
 * This method will generate user analysis based on him activities.
 * @name getUserAnalysis
 * @method
 * @param {String} userId - User's ID.
 * @returns {JSON} Analysis of aggregate of user activities
 * @example
 * var topicList = require('../db/data/topicList.json'); // Your file path as per defined template.
 * var topics = require('../db/data/topics.json'); // Your file path as per defined template.
 * const HSBot = require('hsbot');
 * const hsBot = new HSBot(topicList, topics);
 * var userId = "aQ11zyTr4u7I";
 *
 * hsBot.getUserAnalysis(userId);
 * 
 * @example
 * {
 *  "timeSpent": "100261",
 *  "frequentBotText": "Thank you for contacting us. you can call me by typing @hs anytime for further help.",
 *  "frequentUserText": "@hs"
 * }
 */
HSBot.prototype.getUserAnalysis = function(userId) {
  var user = userDB._findUser(userId);
  var analysisData = analysis._analyzed(user);
  return analysisData;
};

/**
 * This method is responsible to get user details based on userId.
 * @name getChatHistory
 * @method
 * @param {String} userId - User's ID.
 * @example
 * var topicList = require('../db/data/topicList.json'); // Your file path as per defined template.
 * var topics = require('../db/data/topics.json'); // Your file path as per defined template.
 * const HSBot = require('hsbot');
 * const hsBot = new HSBot(topicList, topics);
 * var userId = "aQ11zyTr4u7I";
 *
 * hsBot.getChatHistory(userId);
 * 
 * @returns {JSON} user object.
 * @example
 * {
 *   userName: "Hardik Shah",
 *   userId: "aQ11zyTr4u7I",
 *   loggedIn: 1235637,
 *   activities: [
 *    {
 *      pattern: null,
 *      preQ: "What is your name?",
 *      ut: 12345688,
 *      topic: "call1"
 *    },
 *    {
 *     pattern: "Hardik Shah",
 *     preQ: "Welcome Hardik Shah, How can I assist you?",
 *     ut: 12345999,
 *     topic: "call1"
 *   }
 *  ]
 * }
 */
HSBot.prototype.getChatHistory = function(userId) {
  var user = userDB._findUser(userId);
  return user;
};

/**
 * This method is responsible to get all user details.
 * @name getAllUserChatHistory
 * @method
 * @example
 * var topicList = require('../db/data/topicList.json'); // Your file path as per defined template.
 * var topics = require('../db/data/topics.json'); // Your file path as per defined template.
 * const HSBot = require('hsbot');
 * const hsBot = new HSBot(topicList, topics);
 * var userId = "aQ11zyTr4u7I";
 *
 * hsBot.getChatHistory(userId);
 * 
 * @returns {Array} Array of all user details.
 * 
 * @example
 * [
 *   {
 *     userName: "Hardik Shah",
 *     userId: "aQ11zyTr4u7I",
 *     loggedIn: 1235637,
 *     activities: [
 *      {
 *        pattern: null,
 *        preQ: "What is your name?",
 *        ut: 12345688,
 *        topic: "call1"
 *      },
 *      {
 *        pattern: "Hardik Shah",
 *        preQ: "Welcome Hardik Shah, How can I assist you?",
 *        ut: 12345999,
 *        topic: "call1"
 *      }
 *     ]
 *   },
 *   {
 *     userName: "Kartik Shah",
 *     userId: "aQ11zyTr4u22",
 *     loggedIn: 1235637,
 *     activities: [
 *      {
 *        pattern: null,
 *        preQ: "What is your name?",
 *        ut: 12345688,
 *        topic: "call1"
 *      },
 *      {
 *        pattern: "Kartik Shah",
 *        preQ: "Welcome Kartik Shah, How can I assist you?",
 *        ut: 12345999,
 *        topic: "call1"
 *      }
 *     ]
 *   }
 * ]
 */
HSBot.prototype.getAllUserChatHistory = function() {
  var userList = userDB.mem;
  return userList;
};

module.exports = HSBot;
module.exports.version = require('../package.json').version;

1			/**
2			* hsBot: Supply template and your bot is ready.
3			*
4			* Hardik Shah <[email protected]>
5			*
6			* MIT License
7			*/
8
9			'use strict';
10
11			var ChatDB = require('../db/chatdb');
12			var analysis = new(require('../analysis'))();
13			var userDB = new (require('../db/userdb'))();
14			var common = require('../util/common');
15
16			/**
17			* A collection of `HSBOT` functions for talk with bot and analyze data.
18			* Supply template and your bot is ready.
19			* @name HSBOT
20			* @constructor
21			* @param {Array} topicList - A collection of JSON object.
22			* @param {Array} topics - A collection of JSON object.
23			* @example
24			*
25			* var topicList = require('../db/data/topicList.json'); // Your file path as per defined template.
26			* var topics = require('../db/data/topics.json'); // Your file path as per defined template.
27			* const HSBot = require('hsbot');
28			* const hsBot = new HSBot(topicList, topics);
29			*/
30			function HSBot(topicList, topics) {
31			this.topicList = topicList;
32			this.topics = topics;
33			}
34
35			/**
36			* This method is responsible to reply.
37			* @name transformAndReply
38			* @method
39			* @param {String} userId - User's ID.
40			* @param {String} userName - User name.
41			* @param {String} pattern - A human text or user query.
42			* @return {callback} error-first callback, bot result based on user query.
43			* @example
44			* var topicList = require('../db/data/topicList.json'); // Your file path as per defined template.
45			* var topics = require('../db/data/topics.json'); // Your file path as per defined template.
46			* const HSBot = require('hsbot');
47			* const hsBot = new HSBot(topicList, topics);
48			* var userId = "aQ11zyTr4u7I";
49			* var userName;
50			*
51			* hsBot.transformAndReply(userId, userName, human_text, function(err, data){
52			* console.log("HSBot:", data);
53			* });
54			*/
55
56			HSBot.prototype.transformAndReply = function(userId, userName, pattern, cb) {
57			var topicList = this.topicList;
58			var topics = this.topics;
59			var chatDB = new ChatDB(topicList, topics);
60			pattern = common.string2literal(pattern);
61
62			if(!userId){
63			cb("UserId is not defined.");
64			} else {
65			var user = userDB._findUser(userId);
66			var response;
67			if(!user){
68			response = welcomeUser();
69			cb(null, response);
70			} else {
71			response = transform();
72			cb(null, response);
73			}
74			}
75
76			function welcomeUser() {
77			var template = createUser();
78			var postStringDict = {
79			template: template,
80			userName: userName
81			};
82			return _postTransform(postStringDict);
83			}
84
85			function createUser(){
86			var topicName = chatDB._findDefaultTopic();
87			var topicFlow = chatDB.getTopicFlow(topicName);
88			var templateObj = chatDB.getTemplateObj(userName, topicFlow);
89
90			userDB._insertUser(userId, userName, templateObj.pattern, templateObj.template, topicName);
91			return templateObj.template;
92			}
93
94			function transform() {
95			var lastIndex = user.activities.length -1;
96			var preQ = user.activities[lastIndex].preQ;
97
98			var topicName = pattern? (chatDB._findTopicByCommand(pattern) \|\| user.activities[lastIndex].topic) : chatDB._findDefaultTopic();
99			var topicFlow = chatDB.getTopicFlow(topicName);
100			var templateObj = chatDB.getTemplateObj(user.userName, topicFlow, pattern, preQ);
101
102			if(templateObj){
103			userDB._updateUser(userId, user.userName \|\| pattern, templateObj.pattern, templateObj.template, topicName);
104			} else{
105			templateObj = { template: chatDB.getDefaultMessage() };
106			}
107
108			var postStringDict = {
109			template: templateObj.template,
110			query: pattern,
111			userName: user.userName \|\| pattern
112			};
113
114			return _postTransform(postStringDict);
115			}
116
117			function _postTransform(resObj) {
118			var s = resObj.template;
119			s = s.replace(/[*]/g, resObj.query).replace("<userName>", resObj.userName);
120			return s;
121			}
122			};
123
124			/**
125			* This method will generate user analysis based on him activities.
126			* @name getUserAnalysis
127			* @method
128			* @param {String} userId - User's ID.
129			* @returns {JSON} Analysis of aggregate of user activities
130			* @example
131			* var topicList = require('../db/data/topicList.json'); // Your file path as per defined template.
132			* var topics = require('../db/data/topics.json'); // Your file path as per defined template.
133			* const HSBot = require('hsbot');
134			* const hsBot = new HSBot(topicList, topics);
135			* var userId = "aQ11zyTr4u7I";
136			*
137			* hsBot.getUserAnalysis(userId);
138			*
139			* @example
140			* {
141			* "timeSpent": "100261",
142			* "frequentBotText": "Thank you for contacting us. you can call me by typing @hs anytime for further help.",
143			* "frequentUserText": "@hs"
144			* }
145			*/
146			HSBot.prototype.getUserAnalysis = function(userId) {
147			var user = userDB._findUser(userId);
148			var analysisData = analysis._analyzed(user);
149			return analysisData;
150			};
151
152			/**
153			* This method is responsible to get user details based on userId.
154			* @name getChatHistory
155			* @method
156			* @param {String} userId - User's ID.
157			* @example
158			* var topicList = require('../db/data/topicList.json'); // Your file path as per defined template.
159			* var topics = require('../db/data/topics.json'); // Your file path as per defined template.
160			* const HSBot = require('hsbot');
161			* const hsBot = new HSBot(topicList, topics);
162			* var userId = "aQ11zyTr4u7I";
163			*
164			* hsBot.getChatHistory(userId);
165			*
166			* @returns {JSON} user object.
167			* @example
168			* {
169			* userName: "Hardik Shah",
170			* userId: "aQ11zyTr4u7I",
171			* loggedIn: 1235637,
172			* activities: [
173			* {
174			* pattern: null,
175			* preQ: "What is your name?",
176			* ut: 12345688,
177			* topic: "call1"
178			* },
179			* {
180			* pattern: "Hardik Shah",
181			* preQ: "Welcome Hardik Shah, How can I assist you?",
182			* ut: 12345999,
183			* topic: "call1"
184			* }
185			* ]
186			* }
187			*/
188			HSBot.prototype.getChatHistory = function(userId) {
189			var user = userDB._findUser(userId);
190			return user;
191			};
192
193			/**
194			* This method is responsible to get all user details.
195			* @name getAllUserChatHistory
196			* @method
197			* @example
198			* var topicList = require('../db/data/topicList.json'); // Your file path as per defined template.
199			* var topics = require('../db/data/topics.json'); // Your file path as per defined template.
200			* const HSBot = require('hsbot');
201			* const hsBot = new HSBot(topicList, topics);
202			* var userId = "aQ11zyTr4u7I";
203			*
204			* hsBot.getChatHistory(userId);
205			*
206			* @returns {Array} Array of all user details.
207			*
208			* @example
209			* [
210			* {
211			* userName: "Hardik Shah",
212			* userId: "aQ11zyTr4u7I",
213			* loggedIn: 1235637,
214			* activities: [
215			* {
216			* pattern: null,
217			* preQ: "What is your name?",
218			* ut: 12345688,
219			* topic: "call1"
220			* },
221			* {
222			* pattern: "Hardik Shah",
223			* preQ: "Welcome Hardik Shah, How can I assist you?",
224			* ut: 12345999,
225			* topic: "call1"
226			* }
227			* ]
228			* },
229			* {
230			* userName: "Kartik Shah",
231			* userId: "aQ11zyTr4u22",
232			* loggedIn: 1235637,
233			* activities: [
234			* {
235			* pattern: null,
236			* preQ: "What is your name?",
237			* ut: 12345688,
238			* topic: "call1"
239			* },
240			* {
241			* pattern: "Kartik Shah",
242			* preQ: "Welcome Kartik Shah, How can I assist you?",
243			* ut: 12345999,
244			* topic: "call1"
245			* }
246			* ]
247			* }
248			* ]
249			*/
250			HSBot.prototype.getAllUserChatHistory = function() {
251			var userList = userDB.mem;
252			return userList;
253			};
254
255			module.exports = HSBot;
256			module.exports.version = require('../package.json').version;

hrdk108 / hsbot

HSBot.transformAndReply A last analyzed 2018-03-28 07:41 UTC

Complexity

Size

Duplication

Importance

4 Functions

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like

HSBot.transformAndReply A
last analyzed 2018-03-28 07:41 UTC